C-Script "add-ons" can be very helpful for many users, giving C-Script a "customized" feel.
An "add-on" is simply a loadable addition to C-Script supplied by whoever wants to take the time to create it. Add-ons can enhance C-Script in many different ways, from just adding simple "slap and action" popups to the nickname popups, or changing the whole way you use C-Script... the possibilities are endless.
To browse/download available addons, visit C-Script's addon page at http://www.c-script.com/addons.shtm
Installing Addons:
1. You must download the addon you want to install from http://www.c-script.com/addons.shtm
2. The addon will be in a .zip file format, which means you will need a way to "unzip" it. If you do not already have software that allows you to decompress .zip files, download WinZip from http://www.winzip.com/
3. Unzip the addon.zip file into your \C-Script\addons\ directory.
4. Open up C-Script.
5. Type "/addons" and C-Script will scan your \C-Script\addons\ directory for all files with the extension ".adn"
Any additional installation requirements will be listed if needed.
Help on Installed Addons:
The C-Team will not provide support for C-Script Addons.
If you are having trouble with an addon that you have installed, contact the author of the addon for help. You can usually do this by typing "/addons" or "/scriptinfo" and emailing the email address displayed for that addon.
Creating Addons:
If you know enough about mIRC and C-Script to create your own Add-Ons, I encourage you to do so. Not only will you be able to have your addon listed and rated on C-Scripts addon page and get full credit for it, if we like your addon enough we might ask to be able to include it as part of C-Script. Also, if your addon is so good that it stands out considerably, you might even be considered for a place in one of the C-Script teams!
ALL ADD-ONS MUST MEET THE FOLLOWING REQUIREMENTS:
1. No C-Script alias, variable, text, file, or script can be altered, removed, or replaced in any way.
2. Your .adn file MUST be in the same format as the sample.adn file in the \C-Script\addons\sample\ dir.
3. Variable names must start with your addon suffix, followed by a period, and then the name which you would normally call it. Example: %myaddon.var or %myaddon.count
4. The file extension to load the addon installation routine must be .adn
5. The script itself that will be loaded upon completion of the addon installation should be only ONE file with the extension .mrc loaded into the remote. You may have other files related to your addon included with your addon, but only ONE file may be loaded into the remote.
6. You may add popups using the "menu prefix", but make SURE you keep your popups as short as you can so the popup menus do not get streached out.
7. You MUST include a ".rem" file with your addon that will COMPLETELY uninstall your addon. Please look at the sample.rem file in the \C-Script\addons\sample\ dir for the recommended uninstall procedure.
8. You must submit your addon as a .zip file containing all your addon files.
9. ALL file names related to your addon MUST be 8 characters or under, so they are compatible with Win 3.x.
10. If you would like credit for your addon when a user types /scriptinfo, have your addon set a "%myaddon.adn" variable that has a little information about your addon. Note: This is the ONLY variable that does not have to comply with rule number 3! It MUST however, be "unset" when uninstalled! It must ALSO have the SAME NAME AS YOUR .adn file. For example, if your .adn file was called "myaddon.adn" and your name/nick was Me the variable would be: %myaddon.adn My-Addon's Name v1.1 by Me <me@myself.net>
Helpful reminders:
Remember the following:
Prefix with "on" for events.
Prefix with "alias" for aliases AND custom identifiers.
Prefix with "ctcp" for CTCPs.
Prefix with "raw" for raw events.
Prefix with "menu channel" for Channel popups.
Prefix with "menu nicklist" for Nickname List popups.
Prefix with "menu status" for Status Window popups.
Prefix with "menu query" for Status Window popups.
All custom popups will appear on the BOTTOM of the popup menu.
Some addons may look strange if they do not comply with C-Script's color system. Use $clr(type) in place of static color numbers to make sure text will be viewed correctly. For a list of color 'types', press Alt-K.
You may set as many "%tmp.var" vars in your addon as you like, since %tmp.* is unset on start.
Make sure your addon actually WORKS before submitting it.
To submit your addon, visit http://www.c-script.com/addons.shtm
Disclaimer:
1. The C-Team has the right to refuse any addons that are submitted, for any reason.
2. The C-Team will not be held responsible for anything an addon does, or anything that is included with an addon.
